<?php  if ( ! defined('BASEPATH')) exit('禁止直接访问脚本目录！');
/**
 * CodeIgniter
 *
 * 这是一个PHP开源程序开发框架，要求PHP 5.1.6+
 *
 * @package		CodeIgniter
 * @author		ExpressionEngine Dev Team
 * @copyright	Copyright (c) 2008 - 2011, EllisLab, Inc.
 * @license		http://codeigniter.com/user_guide/license.html
 * @link		http://codeigniter.com
 * @since		Version 1.0
 * @filesource
 */

// ------------------------------------------------------------------------

/**
 * 输入类
 *
 * 安全起见会对输入的全局数据进行预处理
 *
 * @package		CodeIgniter
 * @subpackage	Libraries
 * @category	Input
 * @author		ExpressionEngine Dev Team
 * @link		http://codeigniter.com/user_guide/libraries/input.html
 */
class CI_Input {

	/**
	 * 当前用户的IP地址
	 *
	 * @var string
	 */
	var $ip_address				= FALSE;
	/**
	 * 当前用户正在使用的浏览器类型
	 *
	 * @var string
	 */
	var $user_agent				= FALSE;
	/**
	 * 设置为FALSE表示关闭$_GET数组
	 *
	 * @var bool
	 */
	var $_allow_get_array		= TRUE;
	/**
	 * 设置为TRUE时会对换行符进行标准化转换
	 *
	 * @var bool
	 */
	var $_standardize_newlines	= TRUE;
	/**
	 * 决定是否总是对GET, POST 和 COOKIE数据进行XSS过滤。
	 * 会根据配置文件的配置情况进行自动设置。
	 *
	 * @var bool
	 */
	var $_enable_xss			= FALSE;
	/**
	 * 决定是否开启一个CSRF的cookie令牌。
	 * 会根据配置文件的配置情况进行自动设置
	 *
	 * @var bool
	 */
	var $_enable_csrf			= FALSE;
	/**
	 * 存放所有HTTP请求头信息。
	 *
	 * @var array
	 */
	protected $headers			= array();


	/**
	 * 构造函数
	 *
	 * 设置是否进行XSS全局过滤和是否开启$_GET数组。
	 *
	 */
	public function __construct()
	{
		log_message('debug', "输入类被初始化");

		$this->_allow_get_array	= (config_item('allow_get_array') === TRUE);
		$this->_enable_xss		= (config_item('global_xss_filtering') === TRUE);
		$this->_enable_csrf		= (config_item('csrf_protection') === TRUE);

		global $SEC;
		$this->security =& $SEC;

		// 判断UTF-8类是否开启
		if (UTF8_ENABLED === TRUE)
		{
			global $UNI;
			$this->uni =& $UNI;
		}

		// 过滤全局数组
		$this->_sanitize_globals();
	}

	// --------------------------------------------------------------------

	/**
	 * 获取并过滤数组
	 *
	 * 这是一个过滤全局数组的辅助函数。
	 *
	 * @access	private
	 * @param	array
	 * @param	string
	 * @param	bool
	 * @return	string
	 */
	function _fetch_from_array(&$array, $index = '', $xss_clean = FALSE)
	{
		if ( ! isset($array[$index]))
		{
			return FALSE;
		}

		if ($xss_clean === TRUE)
		{
			return $this->security->xss_clean($array[$index]);
		}

		return $array[$index];
	}

	// --------------------------------------------------------------------

	/**
	* 获取并过滤GET数组的元素
	*
	* @access	public
	* @param	string
	* @param	bool
	* @return	string
	*/
	function get($index = NULL, $xss_clean = FALSE)
	{
		// 检测是否有字段被提供
		if ($index === NULL AND ! empty($_GET))
		{
			$get = array();

			// 循环整个$_GET数组
			foreach (array_keys($_GET) as $key)
			{
				$get[$key] = $this->_fetch_from_array($_GET, $key, $xss_clean);
			}
			return $get;
		}

		return $this->_fetch_from_array($_GET, $index, $xss_clean);
	}

	// --------------------------------------------------------------------

	/**
	* 获取并过滤POST数组的元素
	*
	* @access	public
	* @param	string
	* @param	bool
	* @return	string
	*/
	function post($index = NULL, $xss_clean = FALSE)
	{
		// 检测是否有字段被提供
		if ($index === NULL AND ! empty($_POST))
		{
			$post = array();

			// 循环整个$_POST数组
			foreach (array_keys($_POST) as $key)
			{
				$post[$key] = $this->_fetch_from_array($_POST, $key, $xss_clean);
			}
			return $post;
		}

		return $this->_fetch_from_array($_POST, $index, $xss_clean);
	}


	// --------------------------------------------------------------------

	/**
	* 获取并过滤GET/POST数组的元素
	*
	* @access	public
	* @param	string	键
	* @param	bool	XSS过滤
	* @return	string
	*/
	function get_post($index = '', $xss_clean = FALSE)
	{
		if ( ! isset($_POST[$index]) )
		{
			return $this->get($index, $xss_clean);
		}
		else
		{
			return $this->post($index, $xss_clean);
		}
	}

	// --------------------------------------------------------------------

	/**
	* 获取并过滤COOKIE数组的元素
	*
	* @access	public
	* @param	string
	* @param	bool
	* @return	string
	*/
	function cookie($index = '', $xss_clean = FALSE)
	{
		return $this->_fetch_from_array($_COOKIE, $index, $xss_clean);
	}

	// ------------------------------------------------------------------------

	/**
	* 设置cookie
	*
	* 需要传递六个参数，或者是将所有参数组装成一个关联数组传递。
	*
	* @access	public
	* @param	mixed
	* @param	string	cookie的值
	* @param	string	cookie过期时间，秒
	* @param	string	cookie作用域，通常为:  .yourdomain.com
	* @param	string	cookie作用路径
	* @param	string	cookie前缀
	* @param	bool	是否加密
	* @return	void
	*/
	function set_cookie($name = '', $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = FALSE)
	{
		if (is_array($name))
		{
			// 由于有个$$item，name应该放在数组的最后，不然循环体执行不彻底。
			// 请仔细读代码，才能理解CI这样做的意义！最好是自己动手测试一下这段代码！
			foreach (array('value', 'expire', 'domain', 'path', 'prefix', 'secure', 'name') as $item)
			{
				if (isset($name[$item]))
				{
					$$item = $name[$item];
				}
			}
		}

		if ($prefix == '' AND config_item('cookie_prefix') != '')
		{
			$prefix = config_item('cookie_prefix');
		}
		if ($domain == '' AND config_item('cookie_domain') != '')
		{
			$domain = config_item('cookie_domain');
		}
		if ($path == '/' AND config_item('cookie_path') != '/')
		{
			$path = config_item('cookie_path');
		}
		if ($secure == FALSE AND config_item('cookie_secure') != FALSE)
		{
			$secure = config_item('cookie_secure');
		}

		if ( ! is_numeric($expire))
		{
			$expire = time() - 86500;
		}
		else
		{
			$expire = ($expire > 0) ? time() + $expire : 0;
		}

		setcookie($prefix.$name, $value, $expire, $path, $domain, $secure);
	}

	// --------------------------------------------------------------------

	/**
	* 获取并过滤SERVER数组的元素
	*
	* @access	public
	* @param	string
	* @param	bool
	* @return	string
	*/
	function server($index = '', $xss_clean = FALSE)
	{
		return $this->_fetch_from_array($_SERVER, $index, $xss_clean);
	}

	// --------------------------------------------------------------------

	/**
	* 获取IP地址
	*
	* @access	public
	* @return	string
	*/
	function ip_address()
	{
		if ($this->ip_address !== FALSE)
		{
			return $this->ip_address;
		}

		if (config_item('proxy_ips') != '' && $this->server('HTTP_X_FORWARDED_FOR') && $this->server('REMOTE_ADDR'))
		{
			$proxies = preg_split('/[\s,]/', config_item('proxy_ips'), -1, PREG_SPLIT_NO_EMPTY);
			$proxies = is_array($proxies) ? $proxies : array($proxies);

			$this->ip_address = in_array($_SERVER['REMOTE_ADDR'], $proxies) ? $_SERVER['HTTP_X_FORWARDED_FOR'] : $_SERVER['REMOTE_ADDR'];
		}
		elseif ($this->server('REMOTE_ADDR') AND $this->server('HTTP_CLIENT_IP'))
		{
			$this->ip_address = $_SERVER['HTTP_CLIENT_IP'];
		}
		elseif ($this->server('REMOTE_ADDR'))
		{
			$this->ip_address = $_SERVER['REMOTE_ADDR'];
		}
		elseif ($this->server('HTTP_CLIENT_IP'))
		{
			$this->ip_address = $_SERVER['HTTP_CLIENT_IP'];
		}
		elseif ($this->server('HTTP_X_FORWARDED_FOR'))
		{
			$this->ip_address = $_SERVER['HTTP_X_FORWARDED_FOR'];
		}

		if ($this->ip_address === FALSE)
		{
			$this->ip_address = '0.0.0.0';
			return $this->ip_address;
		}

		if (strpos($this->ip_address, ',') !== FALSE)
		{
			$x = explode(',', $this->ip_address);
			$this->ip_address = trim(end($x));
		}

		if ( ! $this->valid_ip($this->ip_address))
		{
			$this->ip_address = '0.0.0.0';
		}

		return $this->ip_address;
	}

	// --------------------------------------------------------------------

	/**
	* 验证IP地址
	*
	* 根据Geert De Deckere的建议更改后的版本
	*
	* @access	public
	* @param	string
	* @return	string
	*/
	function valid_ip($ip)
	{
		$ip_segments = explode('.', $ip);

		// IP地址是否符合四段规则
		if (count($ip_segments) != 4)
		{
			return FALSE;
		}
		// IP不能以0开始
		if ($ip_segments[0][0] == '0')
		{
			return FALSE;
		}
		// 检测每个单段
		foreach ($ip_segments as $segment)
		{
			// IP段只能是数字，并且不得超过3位或大于255
			if ($segment == '' OR preg_match("/[^0-9]/", $segment) OR $segment > 255 OR strlen($segment) > 3)
			{
				return FALSE;
			}
		}

		return TRUE;
	}

	// --------------------------------------------------------------------

	/**
	* 用户代理
	*
	* @access	public
	* @return	string
	*/
	function user_agent()
	{
		if ($this->user_agent !== FALSE)
		{
			return $this->user_agent;
		}

		$this->user_agent = ( ! isset($_SERVER['HTTP_USER_AGENT'])) ? FALSE : $_SERVER['HTTP_USER_AGENT'];

		return $this->user_agent;
	}

	// --------------------------------------------------------------------

	/**
	* 清除全局数据
	*
	* 该函数的作用如下:
	*
	* 销毁$_GET数据(当查询字符串没有开启时)
	*
	* 在register_globals开启时，清除所有全局数据。
	*
	* 将换行转换为标准的 \n
	*
	* @access	private
	* @return	void
	*/
	function _sanitize_globals()
	{
		// It would be "wrong" to unset any of these GLOBALS.
		// 下面这些不允许销毁。
		$protected = array('_SERVER', '_GET', '_POST', '_FILES', '_REQUEST',
							'_SESSION', '_ENV', 'GLOBALS', 'HTTP_RAW_POST_DATA',
							'system_folder', 'application_folder', 'BM', 'EXT',
							'CFG', 'URI', 'RTR', 'OUT', 'IN');

		// 安全起见销毁全局数据。
		// register_globals = off 时下面的代码还是有效。
		foreach (array($_GET, $_POST, $_COOKIE) as $global)
		{
			if ( ! is_array($global))
			{
				if ( ! in_array($global, $protected))
				{
					global $$global;
					$$global = NULL;
				}
			}
			else
			{
				foreach ($global as $key => $val)
				{
					if ( ! in_array($key, $protected))
					{
						global $$key;
						$$key = NULL;
					}
				}
			}
		}

		// 如果不允许$_GET数组，那么我们将其设置为空数组。
		if ($this->_allow_get_array == FALSE)
		{
			$_GET = array();
		}
		else
		{
			if (is_array($_GET) AND count($_GET) > 0)
			{
				foreach ($_GET as $key => $val)
				{
					$_GET[$this->_clean_input_keys($key)] = $this->_clean_input_data($val);
				}
			}
		}

		// 过滤$_POST数据
		if (is_array($_POST) AND count($_POST) > 0)
		{
			foreach ($_POST as $key => $val)
			{
				$_POST[$this->_clean_input_keys($key)] = $this->_clean_input_data($val);
			}
		}

		// 过滤$_COOKIE数据
		if (is_array($_COOKIE) AND count($_COOKIE) > 0)
		{
			// 同时要摆脱那些被服务器或者是愚蠢的应用程序所设置的，对CI来说一无是处，但是又会
			// 触发“非法键字符”警报的垃圾cookie。
			// http://www.ietf.org/rfc/rfc2109.txt
			// 注意：下面的键名称是用的单引号，这并不是PHP变量。
			unset($_COOKIE['$Version']);
			unset($_COOKIE['$Path']);
			unset($_COOKIE['$Domain']);

			foreach ($_COOKIE as $key => $val)
			{
				$_COOKIE[$this->_clean_input_keys($key)] = $this->_clean_input_data($val);
			}
		}

		// 过滤PHP_SELF
		$_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);


		// CSRF保护检查
		if ($this->_enable_csrf == TRUE)
		{
			$this->security->csrf_verify();
		}

		log_message('debug', "POST与COOKIE全局数组已被过滤");
	}

	// --------------------------------------------------------------------

	/**
	* 过滤输入数据
	*
	* 这是一个辅助函数。用来转义数据和将换行转换为标准换行 \n
	*
	* @access	private
	* @param	string
	* @return	string
	*/
	function _clean_input_data($str)
	{
		if (is_array($str))
		{
			$new_array = array();
			foreach ($str as $key => $val)
			{
				$new_array[$this->_clean_input_keys($key)] = $this->_clean_input_data($val);
			}
			return $new_array;
		}

		/* 
		      当魔术引号开启时，我们将斜杠去除以达到统一的效果。
		      注意：在PHP 5.4中get_magic_quotes_gpc()始终返回 0，即该函数已经过时了。
		*/
		if ( ! is_php('5.4') && get_magic_quotes_gpc())
		{
			$str = stripslashes($str);
		}

		// 如果开启了UTF-8，则进行相应的过滤
		if (UTF8_ENABLED === TRUE)
		{
			$str = $this->uni->clean_string($str);
		}

		// 删除无形字符
		$str = remove_invisible_characters($str);

		// 是否过滤输入数据
		if ($this->_enable_xss === TRUE)
		{
			$str = $this->security->xss_clean($str);
		}

		// 在需要时将换行转换为标准换行
		if ($this->_standardize_newlines == TRUE)
		{
			if (strpos($str, "\r") !== FALSE)
			{
				$str = str_replace(array("\r\n", "\r", "\r\n\n"), PHP_EOL, $str);
			}
		}

		return $str;
	}

	// --------------------------------------------------------------------

	/**
	* 过滤键值
	*
	* 这是一个辅助函数。为防止恶意用户对键值进行利用，我们规定键值的取值范围
	* 只能是下面的字符。
	*
	* @access	private
	* @param	string
	* @return	string
	*/
	function _clean_input_keys($str)
	{
		if ( ! preg_match("/^[a-z0-9:_\/-]+$/i", $str))
		{
			exit('非法键字符！');
		}

		// 开启UTF-8时，进行过滤
		if (UTF8_ENABLED === TRUE)
		{
			$str = $this->uni->clean_string($str);
		}

		return $str;
	}

	// --------------------------------------------------------------------

	/**
	 * 请求头
	 *
	 * 如果你用的Apache的话可以直接调用apache_request_headers()来获取头信息，
	 * 如果是其他服务器的话则未进行定义。
	 *
	 * @param	bool XSS cleaning
	 *
	 * @return array
	 */
	public function request_headers($xss_clean = FALSE)
	{
		// 是不是Apache呢
		if (function_exists('apache_request_headers'))
		{
			$headers = apache_request_headers();
		}
		else
		{
			$headers['Content-Type'] = (isset($_SERVER['CONTENT_TYPE'])) ? $_SERVER['CONTENT_TYPE'] : @getenv('CONTENT_TYPE');

			foreach ($_SERVER as $key => $val)
			{
				if (strncmp($key, 'HTTP_', 5) === 0)
				{
					$headers[substr($key, 5)] = $this->_fetch_from_array($_SERVER, $key, $xss_clean);
				}
			}
		}

		// 将SOME_HEADER形式转换为Some-Header的形式
		foreach ($headers as $key => $val)
		{
			$key = str_replace('_', ' ', strtolower($key));
			$key = str_replace(' ', '-', ucwords($key));

			$this->headers[$key] = $val;
		}

		return $this->headers;
	}

	// --------------------------------------------------------------------

	/**
	 * 获取请求头
	 *
	 * 返回头类成员的单个成员的值。
	 *
	 * @param 	string		$this->headers数组的键
	 * @param	boolean		XSS是否过滤
	 * @return 	mixed		FALSE为失败,字符串为成功
	 */
	public function get_request_header($index, $xss_clean = FALSE)
	{
		if (empty($this->headers))
		{
			$this->request_headers();
		}

		if ( ! isset($this->headers[$index]))
		{
			return FALSE;
		}

		if ($xss_clean === TRUE)
		{
			return $this->security->xss_clean($this->headers[$index]);
		}

		return $this->headers[$index];
	}

	// --------------------------------------------------------------------

	/**
	 * 是否为Ajax请求？
	 *
	 * 检测请求中是否包含HTTP_X_REQUESTED_WITH头
	 *
	 * @return 	boolean
	 */
	public function is_ajax_request()
	{
		return ($this->server('HTTP_X_REQUESTED_WITH') === 'XMLHttpRequest');
	}

	// --------------------------------------------------------------------

	/**
	 * 是否为CLI请求？
	 *
	 * 检测该请求是否来自于命令行
	 *
	 * @return 	boolean
	 */
	public function is_cli_request()
	{
		return (php_sapi_name() == 'cli') or defined('STDIN');
	}

}

/* End of file Input.php */
/* Location: ./system/core/Input.php */